Cancel Pix Scheduling

Cancelar Pix Automático agendado

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/scheduling/:endToEnd/cancel'

Cabeçalhos

Nome	Descrição
Authorization	Obrigatório. Chave da API
x-delfinance-account-id	Obrigatório. O número da conta Delfinance

Parâmetros de Path

Nome	Tipo	Descrição
endToEndId	string	Obrigatório. Identificador da autorização

Parâmetros do Corpo

Nome	Tipo	Descrição
CancellationRequesterType	enum	Opcional. Quem solicitou o cancelamento. Domínios: PAYER RECEIVER
ReceiverIspb	string	Opcional. ISPB do recebedor
RequesterIspb	string	Opcional. ISPB do solicitante
CancellationReqDocument	string	Opcional. Documento do solicitante (CPF/CNPJ)
PayerAccountType	enum	Opcional. Tipo de pessoa solicitante. Domínios: NATURAL LEGAL
BeneficiaryConciliationId	string	Opcional. ID de conciliação do recebedor
CancellationReason	enum	Obrigatório. Motivo do cancelamento. Consulte as opções válidas abaixo.

Motivos de cancelamento

Motivo	Descrição
ACCOUNT_CLOSED	Conta foi encerrada
ACCOUNT_BLOCKED	Conta foi bloqueada
AUTHORIZATION_CANCELLED	Autorização foi cancelada
SETTLEMENT_ERROR	Erro durante a liquidação
OTHER_PARTICIPANT_REQUEST	Solicitado por outro participante
REQUESTED_BY_PAYER	Solicitado pelo pagador
REQUESTED_BY_PAYEE	Solicitado pelo recebedor

{
    "CancellationRequesterType": "PAYER",
    "ReceiverIspb": "00000000",
    "RequesterIspb": "38224857",
    "CancellationReqDocument": "12345678901",
    "PayerAccountType": "NATURAL",
    "BeneficiaryConciliationId": "123e4567-e89b-12d3-a456-426614174000",
    "CancellationReason": "ACCOUNT_CLOSED"
}

Resposta

O status code 200 indica sucesso na consulta.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
    "id": "5448c3b2-3dc0-4dc6-b220-40d5fa04b4b4",
    "recurrenceId": "RR38224857202508303nju144fo11",
    "beneficiaryReconciliationId": "auto5af01ab71f394e689b4713c1495fa",
    "requestedAt": "2026-04-20T00:00:02.635Z",
    "endToEndId": "E38224857202604301500IBC533ZMLRB"
}